home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmDirectionMatch.z / XmDirectionMatch
Text File  |  1998-10-30  |  5KB  |  67 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnnMMMMaaaattttcccchhhh((((3333XXXX))))      UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV      XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnnMMMMaaaattttcccchhhh((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnnMMMMaaaattttcccchhhh - A function that checks for a specified
  10.           direction component
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Xm.h>
  14.           Boolean XmDirectionMatch (_d_1, _d_2)
  15.                   XmDirection     _d_1;
  16.                   XmDirection     _d_2;
  17.           (vvvvooooiiiidddd)
  18.  
  19.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  20.           This page documents Motif 2.1.
  21.  
  22.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.           XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnnMMMMaaaattttcccchhhh compares two XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnn values.  The
  24.           function returns a Boolean value depending on whether or not
  25.           the two input values "match."  The simplest match is when _d_1
  26.           and _d_2 are identical.  However, other matches are possible.
  27.           XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnnMMMMaaaattttcccchhhh attempts to compare specified bits only;
  28.           nonspecified bits automatically match.
  29.  
  30.           For example, suppose that _d_1 equals
  31.           XXXXmmmmTTTTOOOOPPPP____TTTTOOOO____BBBBOOOOTTTTTTTTOOOOMMMM____RRRRIIIIGGGGHHHHTTTT____TTTTOOOO____LLLLEEEEFFFFTTTT. In this case, the function
  32.           will return True if _d_2 equals either XXXXmmmmRRRRIIIIGGGGHHHHTTTT____TTTTOOOO____LLLLEEEEFFFFTTTT or
  33.           XXXXmmmmTTTTOOOOPPPP____TTTTOOOO____BBBBOOOOTTTTTTTTOOOOMMMM. However, the function will return False if
  34.           _d_2 equals XXXXmmmmTTTTOOOOPPPP____TTTTOOOO____BBBBOOOOTTTTTTTTOOOOMMMM____LLLLEEEEFFFFTTTT____TTTTOOOO____RRRRIIIIGGGGHHHHTTTT,
  35.           XXXXmmmmBBBBOOOOTTTTTTTTOOOOMMMM____TTTTOOOO____TTTTOOOOPPPP____RRRRIIIIGGGGHHHHTTTT____TTTTOOOO____LLLLEEEEFFFFTTTT, or
  36.           XXXXmmmmBBBBOOOOTTTTTTTTOOOOMMMM____TTTTOOOO____TTTTOOOOPPPP____LLLLEEEEFFFFTTTT____TTTTOOOO____RRRRIIIIGGGGHHHHTTTT.
  37.  
  38.           Note that direction can be thought of as having three
  39.           components, a horizontal component, a vertical component,
  40.           and the precedence among them. This means that in addition
  41.           to the previously mentioned directions, the function will
  42.           still return False if _d_1 equals
  43.           XXXXmmmmTTTTOOOOPPPP____TTTTOOOO____BBBBOOOOTTTTTTTTOOOOMMMM____RRRRIIIIGGGGHHHHTTTT____TTTTOOOO____LLLLEEEEFFFFTTTT and _d_2 equals
  44.           XXXXmmmmRRRRIIIIGGGGHHHHTTTT____TTTTOOOO____LLLLEEEEFFFFTTTT____TTTTOOOOPPPP____TTTTOOOO____BBBBOOOOTTTTTTTTOOOOMMMM.
  45.  
  46.           _d_1        Specifies an XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnn value.
  47.  
  48.           _d_2        Specifies an XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnn value.
  49.  
  50.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  51.           Returns True if _d_1 "matches" _d_2; otherwise, returns False.
  52.  
  53.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  54.           XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnn(3), XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnnMMMMaaaattttcccchhhhPPPPaaaarrrrttttiiiiaaaallll(3),
  55.           XXXXmmmmDDDDiiiirrrreeeeccccttttiiiioooonnnnTTTTooooSSSSttttrrrriiiinnnnggggDDDDiiiirrrreeeeccccttttiiiioooonnnn(3), XXXXmmmmSSSSttttrrrriiiinnnngggg(3),
  56.           XXXXmmmmSSSSttttrrrriiiinnnnggggDDDDiiiirrrreeeeccccttttiiiioooonnnn(3), and XXXXmmmmSSSSttttrrrriiiinnnnggggDDDDiiiirrrreeeeccccttttiiiioooonnnnTTTTooooDDDDiiiirrrreeeeccccttttiiiioooonnnn(3).
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.